Skip to content

show user friendly error if git is not found #15574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 9, 2023
Merged

show user friendly error if git is not found #15574

merged 1 commit into from
Jan 9, 2023

Conversation

sagor999
Copy link
Contributor

@sagor999 sagor999 commented Jan 4, 2023

Description

Show user friendly error and reason for failure if user uses base image that does not include git.
Otherwise workspace will be stuck in content initialization phase forever, which is a bad user experience.
(We do require base image to have git and gitpod user, but end user may forget about those requirements).
This is how the error will be presented to the user:
image

Related Issue(s)

Fixes #

How to test

Open a repo that uses this gitpod dockerfile:

FROM ubuntu

RUN apt update

Notice it will fail with user friendly error explaining why.

Release Notes

none

Documentation

Werft options:

  • /werft with-local-preview
    If enabled this will build install/preview
  • /werft with-preview
  • /werft with-large-vm
  • /werft with-integration-tests=workspace
    Valid options are all, workspace, webapp, ide, jetbrains, vscode, ssh

@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-pavel-git.1 because the annotations in the pull request description changed
(with .werft/ from main)

@sagor999 sagor999 marked this pull request as ready for review January 4, 2023 22:27
@sagor999 sagor999 requested a review from a team January 4, 2023 22:27
@werft-gitpod-dev-com
Copy link

started the job as gitpod-build-pavel-git.3 because the annotations in the pull request description changed
(with .werft/ from main)

@kylos101
Copy link
Contributor

kylos101 commented Jan 9, 2023

@gitpod-io/engineering-ide hey there, could we trouble you for a review on this PR? It'll help users be more successful earlier with their custom image builds, when they forget to include git.

Copy link
Member

@filiptronicek filiptronicek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lookin' good, captain!

image

@roboquat roboquat merged commit 1512a76 into main Jan 9, 2023
@roboquat roboquat deleted the pavel/git branch January 9, 2023 20:52
@kylos101
Copy link
Contributor

kylos101 commented Jan 9, 2023

Thank you, @filiptronicek ! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deployed: IDE IDE change is running in production deployed Change is completely running in production release-note-none size/XS team: IDE
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants